Skip to content

Conversation

@amrit110
Copy link
Member

This pull request introduces important foundational updates for the project, including the addition of a license, a code of conduct, and enhancements to project documentation. These changes help establish community standards, clarify usage permissions, and improve project visibility.

Project governance and legal:

  • Added an MIT License in the LICENSE file, specifying open-source terms and permissions for software use, modification, and distribution.
  • Introduced a CODE_OF_CONDUCT.md file based on the Contributor Covenant, outlining expected behavior, enforcement procedures, and reporting mechanisms for community interactions.

Documentation and project visibility:

  • Updated README.md to include project badges for PyPI version, code checks, documentation status, and license, improving project transparency and discoverability.

@amrit110 amrit110 self-assigned this Oct 31, 2025
@amrit110 amrit110 added the documentation Improvements or additions to documentation label Oct 31, 2025
@amrit110 amrit110 merged commit cf8eeb3 into main Oct 31, 2025
2 checks passed
@amrit110 amrit110 deleted the add_badges branch October 31, 2025 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants